Add documentation#31
Open
jeremymiller wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This branch makes all the required edits for a documentation page including:
#') to be properly formatted with a title, return value, and to omit/fix examplesroxygen::roxygenise()) so help is available when folks type?[function]in R. This is also a prerequisite for the next stepNote that I did NOT make any changes to documentation (e.g., I used the generic term "value" for all return values and used the function name for all titles). There is plenty of room for future improvement in documentation if that is something you'd like to do.
I did make ONE small edit to an actual function: a correction on line 441 of "harmonize_impute.R" to remove a stray "OA" that was a typo and preventing the library from installing for me.